home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmClipboardStartRetrieve.z / XmClipboardStartRetrieve
Text File  |  1998-10-30  |  8KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttRRRReeeettttrrrriiiieeeevvvveeee((((3333XXXXUUUU))))NNNNIIIIXXXX SSSSyyyysssstttteeeemmmmXXXXVVVVmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttRRRReeeettttrrrriiiieeeevvvveeee((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttRRRReeeettttrrrriiiieeeevvvveeee - A clipboard function that
  10.           prepares to retrieve data from the clipboard
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/CutPaste.h>
  14.           int XmClipboardStartRetrieve (_d_i_s_p_l_a_y, _w_i_n_d_o_w, _t_i_m_e_s_t_a_m_p)
  15.                   Display * _d_i_s_p_l_a_y;
  16.                   Window  _w_i_n_d_o_w;
  17.                   Time    _t_i_m_e_s_t_a_m_p;
  18.           (vvvvooooiiiidddd)
  19.  
  20.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  21.           This page documents Motif 2.1.
  22.  
  23.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttRRRReeeettttrrrriiiieeeevvvveeeetells the clipboard routines that
  25.           the application is ready to start copying an item from the
  26.           clipboard.  The clipboard is locked by this routine and
  27.           stays locked until XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddRRRReeeettttrrrriiiieeeevvvveeee is called. Between
  28.           a call to XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttRRRReeeettttrrrriiiieeeevvvveeee and a call to
  29.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddRRRReeeettttrrrriiiieeeevvvveeee, multiple calls to
  30.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeettttrrrriiiieeeevvvveeee with the same format name result in data
  31.           being incrementally copied from the clipboard until the data
  32.           in that format has all been retrieved.
  33.  
  34.           A return value of _X_m_C_l_i_p_b_o_a_r_d_T_r_u_n_c_a_t_e from calls to
  35.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeettttrrrriiiieeeevvvveeee indicates that more data remains to be
  36.           copied in the given format.  It is recommended that any
  37.           calls to the IIIInnnnqqqquuuuiiiirrrreeee functions that the application needs to
  38.           make to complete the copy from the clipboard be made between
  39.           the call to XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttRRRReeeettttrrrriiiieeeevvvveeee and the first call to
  40.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeettttrrrriiiieeeevvvveeee. This way, the application does not need
  41.           to call XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk and XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddUUUUnnnnlllloooocccckkkk.
  42.  
  43.           _d_i_s_p_l_a_y   Specifies a pointer to the DDDDiiiissssppppllllaaaayyyy structure that
  44.                     was returned in a previous call to XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy or
  45.                     XXXXttttDDDDiiiissssppppllllaaaayyyy.
  46.  
  47.           _w_i_n_d_o_w    Specifies the window ID of a widget that relates
  48.                     the application window to the clipboard. The
  49.                     widget's window ID can be obtained through
  50.                     XXXXttttWWWWiiiinnnnddddoooowwww.  The same application instance should
  51.                     pass the same window ID to each of the clipboard
  52.                     functions that it calls.
  53.  
  54.           _t_i_m_e_s_t_a_m_p Specifies the time of the event that triggered the
  55.                     copy.  A valid timestamp must be supplied; it is
  56.                     not sufficient to use CCCCuuuurrrrrrrreeeennnnttttTTTTiiiimmmmeeee.
  57.  
  58.      RRRREEEETTTTUUUURRRRNNNN
  59.           _X_m_C_l_i_p_b_o_a_r_d_S_u_c_c_e_s_s
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttRRRReeeettttrrrriiiieeeevvvveeee((((3333XXXXUUUU))))NNNNIIIIXXXX SSSSyyyysssstttteeeemmmmXXXXVVVVmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttRRRReeeettttrrrriiiieeeevvvveeee((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     The function is successful.
  75.  
  76.           _X_m_C_l_i_p_b_o_a_r_d_L_o_c_k_e_d
  77.                     The function failed because the clipboard was
  78.                     locked by another application. The application can
  79.                     continue to call the function again with the same
  80.                     parameters until the lock goes away. This gives
  81.                     the application the opportunity to ask if the user
  82.                     wants to keep trying or to give up on the
  83.                     operation.
  84.  
  85.      RRRREEEELLLLAAAATTTTEEEEDDDD
  86.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddRRRReeeettttrrrriiiieeeevvvveeee(3), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeCCCCoooouuuunnnntttt(3),
  87.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt(3), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeLLLLeeeennnnggggtttthhhh(3),
  88.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeePPPPeeeennnnddddiiiinnnnggggIIIItttteeeemmmmssss(3), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk(3),
  89.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeettttrrrriiiieeeevvvveeee(3), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy(3), and
  90.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddUUUUnnnnlllloooocccckkkk(3).
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.